PlotIconHandle

PlotIconHandle
Header:	Icons.h		Carbon status:	Supported

Draws an icon of resource type 'ICON' or 'ICN#' to which you have a handle.

OSErr PlotIconHandle (
    const Rect *theRect, 
    IconAlignmentType align, 
    IconTransformType transform, 
    Handle theIcon
);

theRect: A pointer to the rectangle in which to draw the icon, specified in local coordinates of the current graphics port.
align: Specifies how the function should align the icon within the rectangle. See “Alignment Type Values” for a description of the values you can use in this parameter.
transform: Specifies how the function should modify the appearance of the icon. See “Transform Type Values” for a description of the values you can use in this parameter.
theIcon: A handle to the icon to draw. You must have previously obtained a handle to the icon using the GetIcon function, or GetResource or other Resource Manager functions.

function result: A result code.

DISCUSSION

To plot an icon from an icon suite, you should normally use PlotIconSuite. This function may not draw the icon correctly if you pass it the handle returned in the theIconData parameter of GetIconFromSuite.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.